home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / pchelp.arc / HELP1.DOC < prev    next >
Text File  |  1985-03-03  |  10KB  |  270 lines
  1.  
  2.  
  3.  
  4.  
  5.                      IBM PERSONAL COMPUTER ON-LINE HELP
  6.                          V4.0 by D.N.Ikle' 02/25/85
  7.                          For public domain use only
  8.  
  9.  
  10.  
  11.          PURPOSE
  12.  
  13.          This utility is designed to provide an on-line description of
  14.          all the commands and utilities available on an IBM PC or PC
  15.          compatible hard disk system running DOS 2.x and a variety of
  16.          commercial and public domain utilities.  A stripped down
  17.          version can also be installed on a floppy disk based PC or
  18.          PC compatible system with no hard disk.
  19.  
  20.  
  21.          REQUIREMENTS
  22.  
  23.          The basic requirements are an IBM PC or PC compatible, an 80
  24.          column color or monochrome display, the public domain utility
  25.          DPATH (supplied), and version 2.0 or higher of PC-DOS.  A
  26.          hard disk significantly improves performance but is not
  27.          required.  The public domain utilities LU and USQ are
  28.          required to unpack and unsqueeze the distribution library
  29.          files.
  30.  
  31.  
  32.          INTRODUCTION
  33.  
  34.          The On-Line HELP facility was designed to run on a hard disk
  35.          system which can accomodate a large number of commercial and
  36.          public domain utilities, in addition to the usual DOS 2.x
  37.          commands. In this environment, file access time is minimal,
  38.          and the DOS 2.x tree structure can be used to organize all
  39.          the files necessary to support such a system.
  40.  
  41.          Basically, On-Line HELP consists of the executable file
  42.          HELP.COM and non-executable text files having the extension
  43.          .###.  These text files contain the information displayed by
  44.          the HELP facility for each command referenced by the system.
  45.          For HELP to function properly, appropriate paths must be
  46.          created so that DOS can find the necessary files in whatever
  47.          sub-directory structure the user has created.  Specifically,
  48.          the DOS PATH command is used to locate HELP.COM, and the
  49.          public domain utility DPATH is used to locate the .### files.
  50.  
  51.  
  52.          FILES
  53.  
  54.          On-Line HELP is distributed on bulletin boards in the two
  55.          squeezed library distribution files PC-HELP1.LQR and
  56.          PC-HELP2.LQR.
  57.  
  58.         IBM PERSONAL COMPUTER ON-LINE HELP V4.0 by D.N.Ikle'   Page 2
  59.  
  60.  
  61.  
  62.  
  63.  
  64.          PC-HELP1.LQR contains the following files:
  65.  
  66.            README         Description of the distribution files.
  67.            TEMPLATE       Skeleton HELP display file.
  68.  
  69.            HELP.COM       Executable On-Line HELP file.
  70.            HELP.DOC       Documentation for On-Line HELP.
  71.  
  72.            HELP.###       HELP for On-Line HELP.
  73.            HELPHELP.###   Instructions for On-Line HELP.
  74.            NOTATION.###   Notation used in On-Line HELP.
  75.            SYSTEM.###     Description of the user's system.
  76.            COMMANDS.###   List of available commands and utilities.
  77.  
  78.            DPATH.COM      Public domain path extender utility.
  79.            DPATH.DOC      Documentation for DPATH.
  80.  
  81.            HELPFIL1.LBR   HELP files for DOS 2.0 commands.
  82.  
  83.          PC-HELP2.LQR contains the following files:
  84.  
  85.            README         Description of the distribution files.
  86.            HELPFIL2.LBR   HELP files for The Norton Utilities 3.0.
  87.            HELPFIL3.LBR   HELP files for public domain utilities.
  88.  
  89.          It is assumed that the user has the public domain utilities
  90.          LU and USQ and knows how to unsqueeze and unpack the
  91.          distribution files.
  92.  
  93.  
  94.          INSTALLATION
  95.  
  96.          Following are two possible configurations that can be used as
  97.          examples to enable user to install On-Line HELP on any
  98.          system.  The user is assumed to be capable of creating
  99.          sub-directories and moving files between them.
  100.  
  101.          HARD DISK CONFIGURATION:  Organize the system files into the
  102.          following sub-directories on drive C: :
  103.  
  104.            \                   DOS 2.x internal/external commands.
  105.            \utility            Support files for various utilities.
  106.              \utility\private  Commercial utilities (eg. Norton).
  107.              \utility\public   Public domain utilities.
  108.              \utility\doclib   Public domain utility document files.
  109.  
  110.            \help               HELP files for On-Line HELP.
  111.              \help\pcdos       HELP files for DOS 2.x commands.
  112.              \help\private     HELP files for commercial utilities.
  113.              \help\public      HELP files for public domain utilities.
  114.  
  115.         IBM PERSONAL COMPUTER ON-LINE HELP V4.0 by D.N.Ikle'   Page 3
  116.  
  117.  
  118.  
  119.  
  120.  
  121.          Copy DPATH.COM and HELP.COM into \utility\public and insert
  122.          the following lines into an AUTOEXEC.BAT file in the drive C:
  123.          root directory:
  124.  
  125.            path  c:\;c:\utility\private;c:\utility\public
  126.            dpath c:\help;c:\help\pcdos;c:\help\private;c:\help\public
  127.  
  128.          FLOPPY DISK CONFIGURATION:  Create a system diskette with
  129.          the following sub-directories to be run from drive A: :
  130.  
  131.            \             All DOS and other executable system files.
  132.            \help         HELP files for all commands in \.
  133.  
  134.          Copy DPATH.COM and HELP.COM into \ and insert the following
  135.          lines into an AUTOEXEC.BAT file in the root directory:
  136.  
  137.            path  a:\
  138.            dpath a:\help
  139.  
  140.          Once the files are organized to suit the user's own system
  141.          and the appropriate paths have been created, the On-Line HELP
  142.          facility will be available for use the next time the system
  143.          is booted up.
  144.  
  145.  
  146.          USAGE
  147.  
  148.                              HELP [keyword]
  149.  
  150.          where the optional argument keyword consists of 1 to 8
  151.          characters. Allowable formats are:
  152.  
  153.          1) Type             HELP
  154.  
  155.             to get a menu asking for entry of one of the keywords
  156.             described below.
  157.  
  158.          2) Type             HELP ?
  159.  
  160.             to get a very brief summary of how HELP works.
  161.  
  162.          3) Type             HELP HELP
  163.  
  164.             to get a detailed description of the On-Line HELP
  165.             facility.
  166.  
  167.          4) Type             HELP commandname
  168.  
  169.             to view the HELP display for the requested system command
  170.             or utility.
  171.  
  172.         IBM PERSONAL COMPUTER ON-LINE HELP V4.0 by D.N.Ikle'   Page 4
  173.  
  174.  
  175.  
  176.  
  177.  
  178.          5) Type             HELP featurename
  179.  
  180.             to view the HELP display for the requested special system
  181.             feature. Features currently defined to HELP are those
  182.             describing certain advanced features of DOS 2.x:
  183.  
  184.               ANSI        AUTOEXEC     BATCH           CONFIG(uration)
  185.               FILTERS     PIPES        REDIRECT(ion)
  186.  
  187.             and several special features of On-Line HELP:
  188.  
  189.               COMMANDS    Lists all the commands/utilities available.
  190.               NOTATION    Describes the notation used on HELP screens.
  191.               SYSTEM      Describes all the system enhancements.
  192.  
  193.          Following entry of a valid keyword, 1 to 8 screens of text
  194.          are displayed from the text file that describes the command,
  195.          utility, or feature.  From any individual HELP screen, press
  196.          Enter to return to the HELP menu, or Escape to return to DOS.
  197.          If Escape is pressed, all but the first line of the current
  198.          screen remains on the display to allow the user to enter the
  199.          command at the bottom of the display while viewing most of
  200.          the instructions.  The cursor control keys Up, Dn, PgUp,
  201.          PgDn, Home and End can be used to move backward or forward a
  202.          line or a screen at a time or to display the first or last
  203.          HELP screen in the current file.  These options are
  204.          summarized on line 25 of the display, which also indicates
  205.          whether the file is continued on another screen or the end of
  206.          file has been reached.
  207.  
  208.  
  209.          MAINTENANCE
  210.  
  211.          The individual HELP displays are ASCII text files having the
  212.          extension .###, and they can be easily modified with a good
  213.          text editor ( remember that one screen holds 23 lines of
  214.          text).  Most displays have been kept to one screen for
  215.          simplicity, but some have been extended to more screens where
  216.          needed.  The maximum allowable length of a HELP file is 184
  217.          lines (23 lines x 8 pages) of 80 column text.  The special
  218.          file HELPHELP.### should contain exactly 23 lines of text in
  219.          columns 1 to 75, since its contents are displayed within a
  220.          fixed window.
  221.  
  222.          The HELP files contained in HELPFIL3.LBR were written by the
  223.          author to describe the public domain utilities actually on
  224.          his system.  These must be edited and/or deleted to describe
  225.          the utilities available on other systems.  In addition, the
  226.          .### files contained in PC-HELP1.LQR must be edited to
  227.          conform to the details of the user's own system
  228.          configuration.
  229.  
  230.          Note that if the IBM Personal Editor is used, the files must
  231.          be saved with the NOTABS option.
  232.  
  233.         IBM PERSONAL COMPUTER ON-LINE HELP V4.0 by D.N.Ikle'   Page 5
  234.  
  235.  
  236.  
  237.  
  238.  
  239.          ACKNOWLEDGEMENTS
  240.  
  241.          This program relies entirely on another public domain program
  242.          DPATH, by David Micon, to allow HELP to find the appropriate
  243.          HELP file in the sub-directories containing the .### files.
  244.  
  245.          Version 4.0 is written in Turbo Pascal in order to improve
  246.          performance over earlier versions written in BASIC.  The
  247.          program comtains versions of several public domain Turbo
  248.          procedures without which this effort would not have been
  249.          possible:
  250.  
  251.          FASTWRITE is an inline procedure that writes text to the
  252.          screen quickly, by Marshall Brain.
  253.  
  254.          CLINE allows arguemnts to be picked up from the command line,
  255.          by Joe Doran.
  256.  
  257.          INKEY duplicates the BASIC function INKEY$, by Joe Doran.
  258.  
  259.  
  260.          SOURCE
  261.  
  262.          This utility is placed in the public domain by its author:
  263.  
  264.                               David N. Ikle'
  265.                               1671 Newport Street
  266.                               Denver, CO 80220
  267.                               303-333-9322
  268.  
  269.          Comments and suggestions are welcomed.
  270.